Crate itm

itm

A decoder for the ITM and DWT packet protocol as specifed in the ARMv7-M architecture reference manual, Appendix D4. Any references in this code base refers to this document.

Aside from covering the entirety of the protocol, this crate offers two iterators which reads data from the given Read instance:

• Singles, which decodes each packet in the stream in sequence, yielding TracePackets.

• Timestamps, which continuously decodes packets from the stream until a local timestamp is encountered, yielding a TimestampedTracePackets, which contains a timestamp relative to target reset of when the packets where generated target-side.

Usage is simple:

use itm::{Decoder, DecoderOptions};

// or a std::fs::File, or anything else that implements std::io::Read
let stream: &[u8] = &[
    // ...
];
let mut decoder = Decoder::<&[u8]>::new(stream, DecoderOptions { ignore_eof: false });
for packet in decoder.singles() {
    // ...
}

Re-exports

pub use iter::LocalTimestampOptions;

Modules

cortex_m

Structs

Decoder

ITM/DWT packet protocol decoder.

DecoderOptions

Decoder configuration.

Singles

Iterator that yield TracePacket.

TimestampedTracePackets

A set of timestamped TracePackets.

Timestamps

Iterator that yield TimestampedTracePackets.

TimestampsConfiguration

Timestamps configuration.

Enums

DecoderError

Set of errors that can occur during decode.

ExceptionAction

Denotes the action taken by the processor by a given exception. (Table D4-6)

MalformedPacket

Set of malformed TracePackets that can occur during decode.

MemoryAccessType

Denotes the type of memory access.

Timestamp

Timestamp relative to trace clock start with quality descriptions. In order of decreasing quality:

TimestampDataRelation

Indicates the relationship between the generation of the local timestamp packet and the corresponding ITM or DWT data packet. (Appendix D4.2.4)

TracePacket

The set of valid packet types that can be decoded.